<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>zlib::z_params</title>
<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../../index.html" title="Chapter&#160;1.&#160;Boost.Beast">
<link rel="up" href="../ref.html" title="This Page Intentionally Left Blank 2/2">
<link rel="prev" href="boost__beast__zlib__uInt.html" title="zlib::uInt">
<link rel="next" href="boost__beast__zlib__z_params/avail_in.html" title="zlib::z_params::avail_in">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
<td align="center"><a href="../../../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="boost__beast__zlib__uInt.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../ref.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="boost__beast__zlib__z_params/avail_in.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="beast.ref.boost__beast__zlib__z_params"></a><a class="link" href="boost__beast__zlib__z_params.html" title="zlib::z_params">zlib::z_params</a>
</h4></div></div></div>
<p>
        Deflate codec parameters.
      </p>
<h5>
<a name="beast.ref.boost__beast__zlib__z_params.h0"></a>
        <span class="phrase"><a name="beast.ref.boost__beast__zlib__z_params.synopsis"></a></span><a class="link" href="boost__beast__zlib__z_params.html#beast.ref.boost__beast__zlib__z_params.synopsis">Synopsis</a>
      </h5>
<p>
        Defined in header <code class="literal">&lt;<a href="../../../../../../boost/beast/zlib/zlib.hpp" target="_top">boost/beast/zlib/zlib.hpp</a>&gt;</code>
      </p>
<pre class="programlisting"><span class="keyword">struct</span> <span class="identifier">z_params</span>
</pre>
<h5>
<a name="beast.ref.boost__beast__zlib__z_params.h1"></a>
        <span class="phrase"><a name="beast.ref.boost__beast__zlib__z_params.data_members"></a></span><a class="link" href="boost__beast__zlib__z_params.html#beast.ref.boost__beast__zlib__z_params.data_members">Data
        Members</a>
      </h5>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
                <p>
                  Name
                </p>
              </th>
<th>
                <p>
                  Description
                </p>
              </th>
</tr></thead>
<tbody>
<tr>
<td>
                <p>
                  <a class="link" href="boost__beast__zlib__z_params/avail_in.html" title="zlib::z_params::avail_in"><span class="bold"><strong>avail_in</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  The number of bytes of input available at next_in.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="boost__beast__zlib__z_params/avail_out.html" title="zlib::z_params::avail_out"><span class="bold"><strong>avail_out</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  The remaining bytes of space at next_out.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="boost__beast__zlib__z_params/data_type.html" title="zlib::z_params::data_type"><span class="bold"><strong>data_type</strong></span></a>
                </p>
              </td>
<td>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="boost__beast__zlib__z_params/next_in.html" title="zlib::z_params::next_in"><span class="bold"><strong>next_in</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  A pointer to the next input byte.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="boost__beast__zlib__z_params/next_out.html" title="zlib::z_params::next_out"><span class="bold"><strong>next_out</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  A pointer to the next output byte.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="boost__beast__zlib__z_params/total_in.html" title="zlib::z_params::total_in"><span class="bold"><strong>total_in</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  The total number of input bytes read so far.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="boost__beast__zlib__z_params/total_out.html" title="zlib::z_params::total_out"><span class="bold"><strong>total_out</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  The total number of bytes output so far.
                </p>
              </td>
</tr>
</tbody>
</table></div>
<h5>
<a name="beast.ref.boost__beast__zlib__z_params.h2"></a>
        <span class="phrase"><a name="beast.ref.boost__beast__zlib__z_params.description"></a></span><a class="link" href="boost__beast__zlib__z_params.html#beast.ref.boost__beast__zlib__z_params.description">Description</a>
      </h5>
<p>
        Objects of this type are filled in by callers and provided to the deflate
        codec to define the input and output areas for the next compress or decompress
        operation.
      </p>
<p>
        The application must update next_in and avail_in when avail_in has dropped
        to zero. It must update next_out and avail_out when avail_out has dropped
        to zero. The application must initialize zalloc, zfree and opaque before
        calling the init function. All other fields are set by the compression library
        and must not be updated by the application.
      </p>
<p>
        The fields total_in and total_out can be used for statistics or progress
        reports. After compression, total_in holds the total size of the uncompressed
        data and may be saved for use in the decompressor (particularly if the decompressor
        wants to decompress everything in a single step).
      </p>
<p>
        Convenience header <code class="literal">&lt;<a href="../../../../../../boost/beast/zlib.hpp" target="_top">boost/beast/zlib.hpp</a>&gt;</code>
      </p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright &#169; 2016, 2017 Vinnie Falco<p>
        Distributed under the Boost Software License, Version 1.0. (See accompanying
        file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
      </p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="boost__beast__zlib__uInt.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../ref.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="boost__beast__zlib__z_params/avail_in.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>
